﻿
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- saved from url=(0014)about:internet -->
<html xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:mssdk="winsdk" xmlns:script="urn:script" xmlns:build="urn:build" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="Description" content="The !wmitrace.start extension starts the Event Tracing for Windows (ETW) logger on the target computer."/>
<meta name="MSHAttr" content="PreferredSiteName:MSDN"/>
<meta name="MSHAttr" content="PreferredLib:/library/windows/hardware"/>
<title>!wmitrace.start</title>

<meta name="MS-HAID" content="r34_exts_WMI_0866c5c0-45af-47e1-9582-e55c3b37503c.xml"/>


<link rel="STYLESHEET" type="text/css" HREF="../common/backsdk4.css"/>





<style>
html,div { margin: 0; padding: 0;}

body {
	padding: 0px;
	margin: 0px;
	overflow: auto;
	height: 100%;
}

#winchm_template_button{
	float: right;
	width: 93px;
	top: 7px;
	position: relative;
	text-align: right;
	right: 5px;
	height: auto;
}

#winchm_template_top{
	padding: 0px;
	margin: 0px;
	border-bottom: 1px solid #9B9B9B;
	background-color: #B1CEFE;
}

#winchm_template_navigation{
	margin: 0px;
	padding-top: 7px;
	padding-left: 7px;
	padding-bottom: 3px;
	padding-right: 0px;
	font-size: 8.5pt;
	font-family: Arial, Helvetica, sans-serif;
	font-weight: normal;
	color: #585858;
}

#winchm_template_title{
	margin: 0px;
	padding-top: 4px;
	padding-left: 7px;
	padding-bottom: 7px;
	padding-right: 0px;
	font-size: 18px; 
	font-family: Verdana, Geneva, sans-serif;
	color: #363636;
}

#winchm_template_content{
	margin-top: 20px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	width: auto  !important;
	width: 100%;
}

#winchm_template_footer{
	border-width: 1px;
	border-color: #B1CEFE;
	border-top-style: solid;
	margin-top: 15px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	padding-top: 7px;
	padding-left: 0px;
	padding-bottom: 0px;
	padding-right: 0px;
	font-family: arial, helvetica, sans-serif;
	font-size: 8.5pt;
	color: #696969;
	width: auto;
	text-align: left;
}


#winchm_template_container{
	margin: 0px;
	padding: 0px;
	position: static;
	padding-bottom: 3px;
	overflow: auto;
	background-color: #FFFFFF;
}


@media print
{
#winchm_template_container{
	position: static;	
	margin: 0px;
	padding: 5px;
	
	width: auto;
	height: auto;
	overflow: auto;
}
#winchm_template_button{
visibility:hidden;
}
}

#winchm_template_navigation A:link	{text-decoration: none; color:#004080}
#winchm_template_navigation A:visited  {text-decoration: none; color: #004080}
#winchm_template_navigation A:active {text-decoration: none; color: #004080 }
#winchm_template_navigation A:hover {text-decoration: none;color: #0080FF}

A:link	{text-decoration: underline; color:#0033CC}
A:visited  {text-decoration: underline; color: #0033CC}
A:active {text-decoration: underline; color: #0033CC }
A:hover {text-decoration: underline;color: #FF0000;}
</style>
<script type="text/javascript">
function isMobile(){
Agent = window.navigator.userAgent;
if (Agent.indexOf("iPhone")>=1 || Agent.indexOf("iPad")>=1 || Agent.indexOf("iPod")>=1 || Agent.indexOf("Android")>=1){
return true;
}else{
return false;	
}

}
function d_onresize(){
if (window.navigator.userAgent.indexOf("MSIE")>=1){
document.getElementById('winchm_template_container').style.pixelWidth = document.body.offsetWidth - 3;
document.getElementById('winchm_template_container').style.pixelHeight = document.body.offsetHeight - document.getElementById('winchm_template_top').offsetHeight - 4;
}
document.getElementById('winchm_template_container').style.top = document.getElementById('winchm_template_top').offsetHeight + 'px';
}

function d_onbeforeprint(){
document.getElementById('winchm_template_container').style.width = 'auto';
document.getElementById('winchm_template_container').style.height = 'auto';
}

function d_onafterprint(){
d_onresize();
}

if(!isMobile()){

window.onload = d_onresize;
window.onresize = d_onresize;
window.onbeforeprint = d_onbeforeprint;
window.onafterprint = d_onafterprint;

document.write("<style>\n");
document.write("body {overflow: hidden;}\n");
document.write("#winchm_template_container {position: absolute;overflow: auto;top : 0px;right: 0px;bottom: 0px;left: 0px;}\n");
document.write("</style>\n");
}

</script>
</head>
<body><script language="JavaScript" type="text/JavaScript">
function syn(){
if(parent.nav.tree){
 if(parent.nav.tree.loaded){
  parent.nav.tree.selectNode(2827);
 }else{
  setTimeout("syn()",500);
}
  }else{
  setTimeout("syn()",500);
  }}
if(parent!=self){
  setTimeout("syn()",100);
}else{
  parent.location.href = "../../index.htm?page=debugger/_wmitrace_start.htm";
}
originalOnload = window.onload;
if(originalOnload==null){
window.onload = function(){parent.contentLoaded = true;};
}else{
window.onload = function(){originalOnload();parent.contentLoaded = true;};
}
</script> 


<div id="winchm_template_top">
	<div id="winchm_template_button"><A href="_wmitrace_setprefix.htm" title="Previous topic"><img id="winchm_template_prev" alt="Previous topic" src="../template2/btn_prev_n.gif" border="0"></a><A href="_wmitrace_stop.htm" title="Next topic"><img id="winchm_template_next" alt="Next topic" src="../template2/btn_next_n.gif" border="0"></a></div>
	<div id="winchm_template_navigation">Help &gt; 
<A href="introduction6.htm">Debugging Tools for Windows (WinDbg, KD, CDB, NTSD)</A> &gt; <A href="debugger_reference.htm">Debugger Reference</A> &gt; <A href="debugger_commands.htm">Debugger Commands</A> &gt; <A href="specialized_extensions.htm">Specialized Extension Commands</A> &gt; <A href="wmi_tracing_extensions__wmitrace_dll_.htm">WMI Tracing Extensions (Wmitrace.dll)</A> &gt; </div>
	<div id="winchm_template_title">!wmitrace.start</div>
</div>
<div id="winchm_template_container">
	<div id="winchm_template_content"><div id="mainSection"><p>The <b>!wmitrace.start</b> extension starts the Event Tracing for Windows (ETW) logger on the target computer. </p>
<pre class="syntax"><b>!wmitrace.start </b><i>LoggerName</i><b> [-cir </b><i>Size</i><b> | -seq </b><i>Size</i><b>] [-f </b><i>File</i><b>] [-b </b><i>Size</i><b>] [-max </b><i>Num</i><b>] [-min </b><i>Num</i><b>] [-kd] [-ft </b><i>Time</i><b>]</b> 
</pre>
<h2><a id="ddk__wmitrace_strdump_dbg"></a><a id="DDK__WMITRACE_STRDUMP_DBG"></a>Parameters</h2>
<p></p>
<dl>
<dt><a id="_______LoggerName______"></a><a id="_______loggername______"></a><a id="_______LOGGERNAME______"></a>       <i>LoggerName</i>      </dt>
<dd>
<p>Supplies a name to be used for the trace session. <i>LoggerName</i> cannot contain spaces or quotation marks.  </p>
</dd>
<dt><a id="_______-cir_______Size______"></a><a id="_______-cir_______size______"></a><a id="_______-CIR_______SIZE______"></a>       <b>-cir       </b><i>Size</i>      </dt>
<dd>
<p>Causes the log file to be written in a circular manner.  <i>Size</i> specifies the maximum file size, in bytes.  When the file reaches this length, new data will be written to the file in a circular manner, overwriting the file from beginning to end.  This cannot be combined with the <b>-seq</b> parameter.  If neither <b>-cir</b> nor <b>-seq</b> is specified, the file is written in buffered mode. </p>
</dd>
<dt><a id="_______-seq_______Num______"></a><a id="_______-seq_______num______"></a><a id="_______-SEQ_______NUM______"></a>       <b>-seq       </b><i>Num</i>      </dt>
<dd>
<p>Causes the log file to be written in a sequential manner.  <i>Size</i> specifies the maximum file size, in bytes.  When the file reaches this length, the oldest data will be deleted from the beginning of the file whenever new data is appended to the end.  This cannot be combined with the <b>-cir</b> parameter.  If neither <b>-cir</b> nor <b>-seq</b> is specified, the file is written in buffered mode. </p>
</dd>
<dt><a id="_______-f_______File______"></a><a id="_______-f_______file______"></a><a id="_______-F_______FILE______"></a>       <b>-f       </b><i>File</i>      </dt>
<dd>
<p>Specifies the name of the log file to be created on the target computer. <i>File</i> must include an absolute directory path, and cannot contain spaces or quotation marks. </p>
</dd>
<dt><a id="_______-b_______Size______"></a><a id="_______-b_______size______"></a><a id="_______-B_______SIZE______"></a>       <b>-b       </b><i>Size</i>      </dt>
<dd>
<p>Specifies the size of each buffer, in kilobytes. The permissible range of <i>Size</i> is between 1 and 2048, inclusive. </p>
</dd>
<dt><a id="_______-max_______Num______"></a><a id="_______-max_______num______"></a><a id="_______-MAX_______NUM______"></a><b>       -max       </b><i>Num</i>      </dt>
<dd>
<p>Specifies the maximum number of buffers to use.  <i>Num</i> can be any positive integer. </p>
</dd>
<dt><a id="_______-min_______Num______"></a><a id="_______-min_______num______"></a><a id="_______-MIN_______NUM______"></a>       <b>-min       </b><i>Num</i>      </dt>
<dd>
<p>Specifies the minimum number of buffers to use.  <i>Num</i> can be any positive integer. </p>
</dd>
<dt><a id="_______-kd______"></a><a id="_______-KD______"></a>       <b>-kd</b>      </dt>
<dd>
<p>Enables KD filter mode. Messages will be sent to the kernel debugger and displayed on the screen. </p>
</dd>
<dt><a id="_______-ft_______Time______"></a><a id="_______-ft_______time______"></a><a id="_______-FT_______TIME______"></a>       <b>-ft       </b><i>Time</i>      </dt>
<dd>
<p>Specifies the duration of the flush timer, in seconds. Starting in Windows 8, you can specify the flush timer duration in milliseconds by appending <b>ms</b> to the <i>Time</i> value. For example, <b>-ft 100ms</b>.</p>
<div class="alert"><b>Note</b>  If you start a tracing session in KD filter mode (<b>-kd</b>), trace buffers on the target computer are sent to the debugger on the host computer for display. This parameter specifies how often the buffers on the target computer are flushed and sent to the host computer.</div>
<div> </div>
</dd>
</dl>
<h3><a id="DLL"></a><a id="dll"></a>DLL</h3>
<p>This extension is exported by Wmitrace.dll. </p>
<p>This extension is available in Windows 7 and later versions of Windows. </p>
<h3><a id="Additional_Information"></a><a id="additional_information"></a><a id="ADDITIONAL_INFORMATION"></a>Additional Information</h3>
<p>For more details on the parameters of this extension, see <a href="http://go.microsoft.com/fwlink/p/?linkid=139652">StartTrace Function</a> and <a href="http://go.microsoft.com/fwlink/p/?linkid=139653">EVENT_TRACE_PROPERTIES</a> on MSDN. For a conceptual overview of event tracing, see the Microsoft Windows SDK. For information about tracing tools, see the Windows Driver Kit (WDK).</p>
<h2>Remarks</h2>
<p>After using this extension, you must resume program execution (for example, by using the <a href="#Bookmark1997"><b>g (Go)</b></a> command) in order for it to take effect.  After a brief time, the target computer automatically breaks into the debugger again. </p>
<p>When the trace session is started, the system assigns it an ordinal number (the <i>logger ID</i>). The session can then be referred to either by the logger name or the logger ID. </p>
<p>To stop the ETW logger, use <a href="#Bookmark2828"><b>!wmitrace.stop</b></a>. </p></div></div>	
	<div id="winchm_template_footer">Copyright &copy; 2019. All rights 
reserved. (To change the copyright info, just edit it in template.)</div>
</div>

</body>
</html>
